<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Copyright (C) 2007 The Guava Authors<a name="line.2"></a>
<span class="sourceLineNo">003</span> *<a name="line.3"></a>
<span class="sourceLineNo">004</span> * Licensed under the Apache License, Version 2.0 (the "License");<a name="line.4"></a>
<span class="sourceLineNo">005</span> * you may not use this file except in compliance with the License.<a name="line.5"></a>
<span class="sourceLineNo">006</span> * You may obtain a copy of the License at<a name="line.6"></a>
<span class="sourceLineNo">007</span> *<a name="line.7"></a>
<span class="sourceLineNo">008</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * Unless required by applicable law or agreed to in writing, software<a name="line.10"></a>
<span class="sourceLineNo">011</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.11"></a>
<span class="sourceLineNo">012</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.12"></a>
<span class="sourceLineNo">013</span> * See the License for the specific language governing permissions and<a name="line.13"></a>
<span class="sourceLineNo">014</span> * limitations under the License.<a name="line.14"></a>
<span class="sourceLineNo">015</span> */<a name="line.15"></a>
<span class="sourceLineNo">016</span><a name="line.16"></a>
<span class="sourceLineNo">017</span>package com.google.common.collect;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import static com.google.common.base.Preconditions.checkNotNull;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import com.google.common.annotations.GwtCompatible;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import com.google.common.annotations.GwtIncompatible;<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.io.IOException;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.io.ObjectInputStream;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.io.ObjectOutputStream;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.Collection;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.Comparator;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.SortedMap;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import java.util.SortedSet;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import java.util.TreeMap;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import java.util.TreeSet;<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span>/**<a name="line.34"></a>
<span class="sourceLineNo">035</span> * Implementation of {@code Multimap} whose keys and values are ordered by<a name="line.35"></a>
<span class="sourceLineNo">036</span> * their natural ordering or by supplied comparators. In all cases, this<a name="line.36"></a>
<span class="sourceLineNo">037</span> * implementation uses {@link Comparable#compareTo} or {@link<a name="line.37"></a>
<span class="sourceLineNo">038</span> * Comparator#compare} instead of {@link Object#equals} to determine<a name="line.38"></a>
<span class="sourceLineNo">039</span> * equivalence of instances.<a name="line.39"></a>
<span class="sourceLineNo">040</span> *<a name="line.40"></a>
<span class="sourceLineNo">041</span> * &lt;p&gt;&lt;b&gt;Warning:&lt;/b&gt; The comparators or comparables used must be &lt;i&gt;consistent<a name="line.41"></a>
<span class="sourceLineNo">042</span> * with equals&lt;/i&gt; as explained by the {@link Comparable} class specification.<a name="line.42"></a>
<span class="sourceLineNo">043</span> * Otherwise, the resulting multiset will violate the general contract of {@link<a name="line.43"></a>
<span class="sourceLineNo">044</span> * SetMultimap}, which it is specified in terms of {@link Object#equals}.<a name="line.44"></a>
<span class="sourceLineNo">045</span> *<a name="line.45"></a>
<span class="sourceLineNo">046</span> * &lt;p&gt;The collections returned by {@code keySet} and {@code asMap} iterate<a name="line.46"></a>
<span class="sourceLineNo">047</span> * through the keys according to the key comparator ordering or the natural<a name="line.47"></a>
<span class="sourceLineNo">048</span> * ordering of the keys. Similarly, {@code get}, {@code removeAll}, and {@code<a name="line.48"></a>
<span class="sourceLineNo">049</span> * replaceValues} return collections that iterate through the values according<a name="line.49"></a>
<span class="sourceLineNo">050</span> * to the value comparator ordering or the natural ordering of the values. The<a name="line.50"></a>
<span class="sourceLineNo">051</span> * collections generated by {@code entries}, {@code keys}, and {@code values}<a name="line.51"></a>
<span class="sourceLineNo">052</span> * iterate across the keys according to the above key ordering, and for each<a name="line.52"></a>
<span class="sourceLineNo">053</span> * key they iterate across the values according to the value ordering.<a name="line.53"></a>
<span class="sourceLineNo">054</span> *<a name="line.54"></a>
<span class="sourceLineNo">055</span> * &lt;p&gt;The multimap does not store duplicate key-value pairs. Adding a new<a name="line.55"></a>
<span class="sourceLineNo">056</span> * key-value pair equal to an existing key-value pair has no effect.<a name="line.56"></a>
<span class="sourceLineNo">057</span> *<a name="line.57"></a>
<span class="sourceLineNo">058</span> * &lt;p&gt;Null keys and values are permitted (provided, of course, that the<a name="line.58"></a>
<span class="sourceLineNo">059</span> * respective comparators support them). All optional multimap methods are<a name="line.59"></a>
<span class="sourceLineNo">060</span> * supported, and all returned views are modifiable.<a name="line.60"></a>
<span class="sourceLineNo">061</span> *<a name="line.61"></a>
<span class="sourceLineNo">062</span> * &lt;p&gt;This class is not threadsafe when any concurrent operations update the<a name="line.62"></a>
<span class="sourceLineNo">063</span> * multimap. Concurrent read operations will work correctly. To allow concurrent<a name="line.63"></a>
<span class="sourceLineNo">064</span> * update operations, wrap your multimap with a call to {@link<a name="line.64"></a>
<span class="sourceLineNo">065</span> * Multimaps#synchronizedSortedSetMultimap}.<a name="line.65"></a>
<span class="sourceLineNo">066</span> * <a name="line.66"></a>
<span class="sourceLineNo">067</span> * &lt;p&gt;See the Guava User Guide article on &lt;a href=<a name="line.67"></a>
<span class="sourceLineNo">068</span> * "http://code.google.com/p/guava-libraries/wiki/NewCollectionTypesExplained#Multimap"&gt;<a name="line.68"></a>
<span class="sourceLineNo">069</span> * {@code Multimap}&lt;/a&gt;.<a name="line.69"></a>
<span class="sourceLineNo">070</span> *<a name="line.70"></a>
<span class="sourceLineNo">071</span> * @author Jared Levy<a name="line.71"></a>
<span class="sourceLineNo">072</span> * @since 2.0 (imported from Google Collections Library)<a name="line.72"></a>
<span class="sourceLineNo">073</span> */<a name="line.73"></a>
<span class="sourceLineNo">074</span>@GwtCompatible(serializable = true, emulated = true)<a name="line.74"></a>
<span class="sourceLineNo">075</span>public class TreeMultimap&lt;K, V&gt; extends AbstractSortedSetMultimap&lt;K, V&gt; {<a name="line.75"></a>
<span class="sourceLineNo">076</span>  private transient Comparator&lt;? super K&gt; keyComparator;<a name="line.76"></a>
<span class="sourceLineNo">077</span>  private transient Comparator&lt;? super V&gt; valueComparator;<a name="line.77"></a>
<span class="sourceLineNo">078</span><a name="line.78"></a>
<span class="sourceLineNo">079</span>  /**<a name="line.79"></a>
<span class="sourceLineNo">080</span>   * Creates an empty {@code TreeMultimap} ordered by the natural ordering of<a name="line.80"></a>
<span class="sourceLineNo">081</span>   * its keys and values.<a name="line.81"></a>
<span class="sourceLineNo">082</span>   */<a name="line.82"></a>
<span class="sourceLineNo">083</span>  public static &lt;K extends Comparable, V extends Comparable&gt;<a name="line.83"></a>
<span class="sourceLineNo">084</span>      TreeMultimap&lt;K, V&gt; create() {<a name="line.84"></a>
<span class="sourceLineNo">085</span>    return new TreeMultimap&lt;K, V&gt;(Ordering.natural(), Ordering.natural());<a name="line.85"></a>
<span class="sourceLineNo">086</span>  }<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span>  /**<a name="line.88"></a>
<span class="sourceLineNo">089</span>   * Creates an empty {@code TreeMultimap} instance using explicit comparators.<a name="line.89"></a>
<span class="sourceLineNo">090</span>   * Neither comparator may be null; use {@link Ordering#natural()} to specify<a name="line.90"></a>
<span class="sourceLineNo">091</span>   * natural order.<a name="line.91"></a>
<span class="sourceLineNo">092</span>   *<a name="line.92"></a>
<span class="sourceLineNo">093</span>   * @param keyComparator the comparator that determines the key ordering<a name="line.93"></a>
<span class="sourceLineNo">094</span>   * @param valueComparator the comparator that determines the value ordering<a name="line.94"></a>
<span class="sourceLineNo">095</span>   */<a name="line.95"></a>
<span class="sourceLineNo">096</span>  public static &lt;K, V&gt; TreeMultimap&lt;K, V&gt; create(<a name="line.96"></a>
<span class="sourceLineNo">097</span>      Comparator&lt;? super K&gt; keyComparator,<a name="line.97"></a>
<span class="sourceLineNo">098</span>      Comparator&lt;? super V&gt; valueComparator) {<a name="line.98"></a>
<span class="sourceLineNo">099</span>    return new TreeMultimap&lt;K, V&gt;(checkNotNull(keyComparator),<a name="line.99"></a>
<span class="sourceLineNo">100</span>        checkNotNull(valueComparator));<a name="line.100"></a>
<span class="sourceLineNo">101</span>  }<a name="line.101"></a>
<span class="sourceLineNo">102</span><a name="line.102"></a>
<span class="sourceLineNo">103</span>  /**<a name="line.103"></a>
<span class="sourceLineNo">104</span>   * Constructs a {@code TreeMultimap}, ordered by the natural ordering of its<a name="line.104"></a>
<span class="sourceLineNo">105</span>   * keys and values, with the same mappings as the specified multimap.<a name="line.105"></a>
<span class="sourceLineNo">106</span>   *<a name="line.106"></a>
<span class="sourceLineNo">107</span>   * @param multimap the multimap whose contents are copied to this multimap<a name="line.107"></a>
<span class="sourceLineNo">108</span>   */<a name="line.108"></a>
<span class="sourceLineNo">109</span>  public static &lt;K extends Comparable, V extends Comparable&gt;<a name="line.109"></a>
<span class="sourceLineNo">110</span>      TreeMultimap&lt;K, V&gt; create(Multimap&lt;? extends K, ? extends V&gt; multimap) {<a name="line.110"></a>
<span class="sourceLineNo">111</span>    return new TreeMultimap&lt;K, V&gt;(Ordering.natural(), Ordering.natural(),<a name="line.111"></a>
<span class="sourceLineNo">112</span>        multimap);<a name="line.112"></a>
<span class="sourceLineNo">113</span>  }<a name="line.113"></a>
<span class="sourceLineNo">114</span><a name="line.114"></a>
<span class="sourceLineNo">115</span>  TreeMultimap(Comparator&lt;? super K&gt; keyComparator,<a name="line.115"></a>
<span class="sourceLineNo">116</span>      Comparator&lt;? super V&gt; valueComparator) {<a name="line.116"></a>
<span class="sourceLineNo">117</span>    super(new TreeMap&lt;K, Collection&lt;V&gt;&gt;(keyComparator));<a name="line.117"></a>
<span class="sourceLineNo">118</span>    this.keyComparator = keyComparator;<a name="line.118"></a>
<span class="sourceLineNo">119</span>    this.valueComparator = valueComparator;<a name="line.119"></a>
<span class="sourceLineNo">120</span>  }<a name="line.120"></a>
<span class="sourceLineNo">121</span><a name="line.121"></a>
<span class="sourceLineNo">122</span>  private TreeMultimap(Comparator&lt;? super K&gt; keyComparator,<a name="line.122"></a>
<span class="sourceLineNo">123</span>      Comparator&lt;? super V&gt; valueComparator,<a name="line.123"></a>
<span class="sourceLineNo">124</span>      Multimap&lt;? extends K, ? extends V&gt; multimap) {<a name="line.124"></a>
<span class="sourceLineNo">125</span>    this(keyComparator, valueComparator);<a name="line.125"></a>
<span class="sourceLineNo">126</span>    putAll(multimap);<a name="line.126"></a>
<span class="sourceLineNo">127</span>  }<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span>  /**<a name="line.129"></a>
<span class="sourceLineNo">130</span>   * {@inheritDoc}<a name="line.130"></a>
<span class="sourceLineNo">131</span>   *<a name="line.131"></a>
<span class="sourceLineNo">132</span>   * &lt;p&gt;Creates an empty {@code TreeSet} for a collection of values for one key.<a name="line.132"></a>
<span class="sourceLineNo">133</span>   *<a name="line.133"></a>
<span class="sourceLineNo">134</span>   * @return a new {@code TreeSet} containing a collection of values for one<a name="line.134"></a>
<span class="sourceLineNo">135</span>   *     key<a name="line.135"></a>
<span class="sourceLineNo">136</span>   */<a name="line.136"></a>
<span class="sourceLineNo">137</span>  @Override SortedSet&lt;V&gt; createCollection() {<a name="line.137"></a>
<span class="sourceLineNo">138</span>    return new TreeSet&lt;V&gt;(valueComparator);<a name="line.138"></a>
<span class="sourceLineNo">139</span>  }<a name="line.139"></a>
<span class="sourceLineNo">140</span><a name="line.140"></a>
<span class="sourceLineNo">141</span>  /**<a name="line.141"></a>
<span class="sourceLineNo">142</span>   * Returns the comparator that orders the multimap keys.<a name="line.142"></a>
<span class="sourceLineNo">143</span>   */<a name="line.143"></a>
<span class="sourceLineNo">144</span>  public Comparator&lt;? super K&gt; keyComparator() {<a name="line.144"></a>
<span class="sourceLineNo">145</span>    return keyComparator;<a name="line.145"></a>
<span class="sourceLineNo">146</span>  }<a name="line.146"></a>
<span class="sourceLineNo">147</span><a name="line.147"></a>
<span class="sourceLineNo">148</span>  @Override<a name="line.148"></a>
<span class="sourceLineNo">149</span>  public Comparator&lt;? super V&gt; valueComparator() {<a name="line.149"></a>
<span class="sourceLineNo">150</span>    return valueComparator;<a name="line.150"></a>
<span class="sourceLineNo">151</span>  }<a name="line.151"></a>
<span class="sourceLineNo">152</span><a name="line.152"></a>
<span class="sourceLineNo">153</span>  /**<a name="line.153"></a>
<span class="sourceLineNo">154</span>   * {@inheritDoc}<a name="line.154"></a>
<span class="sourceLineNo">155</span>   *<a name="line.155"></a>
<span class="sourceLineNo">156</span>   * &lt;p&gt;Because a {@code TreeMultimap} has unique sorted keys, this method<a name="line.156"></a>
<span class="sourceLineNo">157</span>   * returns a {@link SortedSet}, instead of the {@link java.util.Set} specified<a name="line.157"></a>
<span class="sourceLineNo">158</span>   * in the {@link Multimap} interface.<a name="line.158"></a>
<span class="sourceLineNo">159</span>   */<a name="line.159"></a>
<span class="sourceLineNo">160</span>  @Override public SortedSet&lt;K&gt; keySet() {<a name="line.160"></a>
<span class="sourceLineNo">161</span>    return (SortedSet&lt;K&gt;) super.keySet();<a name="line.161"></a>
<span class="sourceLineNo">162</span>  }<a name="line.162"></a>
<span class="sourceLineNo">163</span><a name="line.163"></a>
<span class="sourceLineNo">164</span>  /**<a name="line.164"></a>
<span class="sourceLineNo">165</span>   * {@inheritDoc}<a name="line.165"></a>
<span class="sourceLineNo">166</span>   *<a name="line.166"></a>
<span class="sourceLineNo">167</span>   * &lt;p&gt;Because a {@code TreeMultimap} has unique sorted keys, this method<a name="line.167"></a>
<span class="sourceLineNo">168</span>   * returns a {@link SortedMap}, instead of the {@link java.util.Map} specified<a name="line.168"></a>
<span class="sourceLineNo">169</span>   * in the {@link Multimap} interface.<a name="line.169"></a>
<span class="sourceLineNo">170</span>   */<a name="line.170"></a>
<span class="sourceLineNo">171</span>  @Override public SortedMap&lt;K, Collection&lt;V&gt;&gt; asMap() {<a name="line.171"></a>
<span class="sourceLineNo">172</span>    return (SortedMap&lt;K, Collection&lt;V&gt;&gt;) super.asMap();<a name="line.172"></a>
<span class="sourceLineNo">173</span>  }<a name="line.173"></a>
<span class="sourceLineNo">174</span><a name="line.174"></a>
<span class="sourceLineNo">175</span>  /**<a name="line.175"></a>
<span class="sourceLineNo">176</span>   * @serialData key comparator, value comparator, number of distinct keys, and<a name="line.176"></a>
<span class="sourceLineNo">177</span>   *     then for each distinct key: the key, number of values for that key, and<a name="line.177"></a>
<span class="sourceLineNo">178</span>   *     key values<a name="line.178"></a>
<span class="sourceLineNo">179</span>   */<a name="line.179"></a>
<span class="sourceLineNo">180</span>  @GwtIncompatible("java.io.ObjectOutputStream")<a name="line.180"></a>
<span class="sourceLineNo">181</span>  private void writeObject(ObjectOutputStream stream) throws IOException {<a name="line.181"></a>
<span class="sourceLineNo">182</span>    stream.defaultWriteObject();<a name="line.182"></a>
<span class="sourceLineNo">183</span>    stream.writeObject(keyComparator());<a name="line.183"></a>
<span class="sourceLineNo">184</span>    stream.writeObject(valueComparator());<a name="line.184"></a>
<span class="sourceLineNo">185</span>    Serialization.writeMultimap(this, stream);<a name="line.185"></a>
<span class="sourceLineNo">186</span>  }<a name="line.186"></a>
<span class="sourceLineNo">187</span><a name="line.187"></a>
<span class="sourceLineNo">188</span>  @GwtIncompatible("java.io.ObjectInputStream")<a name="line.188"></a>
<span class="sourceLineNo">189</span>  @SuppressWarnings("unchecked") // reading data stored by writeObject<a name="line.189"></a>
<span class="sourceLineNo">190</span>  private void readObject(ObjectInputStream stream)<a name="line.190"></a>
<span class="sourceLineNo">191</span>      throws IOException, ClassNotFoundException {<a name="line.191"></a>
<span class="sourceLineNo">192</span>    stream.defaultReadObject();<a name="line.192"></a>
<span class="sourceLineNo">193</span>    keyComparator = checkNotNull((Comparator&lt;? super K&gt;) stream.readObject());<a name="line.193"></a>
<span class="sourceLineNo">194</span>    valueComparator = checkNotNull((Comparator&lt;? super V&gt;) stream.readObject());<a name="line.194"></a>
<span class="sourceLineNo">195</span>    setMap(new TreeMap&lt;K, Collection&lt;V&gt;&gt;(keyComparator));<a name="line.195"></a>
<span class="sourceLineNo">196</span>    Serialization.populateMultimap(this, stream);<a name="line.196"></a>
<span class="sourceLineNo">197</span>  }<a name="line.197"></a>
<span class="sourceLineNo">198</span><a name="line.198"></a>
<span class="sourceLineNo">199</span>  @GwtIncompatible("not needed in emulated source")<a name="line.199"></a>
<span class="sourceLineNo">200</span>  private static final long serialVersionUID = 0;<a name="line.200"></a>
<span class="sourceLineNo">201</span>}<a name="line.201"></a>




























































</pre>
</div>
</body>
</html>
